Move documentation to inline comments: GtkPlug

https://bugzilla.gnome.org/show_bug.cgi?id=611707

Signed-off-by: Javier Jardón <jjardon@gnome.org>

diff --git a/docs/reference/gtk/tmpl/gtkplug.sgml b/docs/reference/gtk/tmpl/gtkplug.sgml
deleted file mode 100644 (file)
index 3aa5179..0000000
--- a/docs/reference/gtk/tmpl/gtkplug.sgml
+++ /dev/null
@@ -1,126 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkPlug
-
-<!-- ##### SECTION Short_Description ##### -->
-Toplevel for embedding into other processes
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-Together with #GtkSocket, #GtkPlug provides the ability
-to embed widgets from one process into another process
-in a fashion that is transparent to the user. One
-process creates a #GtkSocket widget and, passes the
-ID of that widgets window to the other process, 
-which then creates a #GtkPlug with that window ID.
-Any widgets contained in the #GtkPlug then will appear
-inside the first applications window.
-</para>
-
-<note>
-<para>
-The #GtkPlug and #GtkSocket widgets are currently not available 
-on all platforms supported by GTK+.
-</para>
-</note>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-
-<varlistentry>
-<term>#GtkSocket</term>
-<listitem><para>the widget that a #GtkPlug plugs into.</para></listitem>
-</varlistentry>
-
-</variablelist>
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GtkPlug ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GtkPlug::embedded ##### -->
-<para>
-
-</para>
-
-@plug: the object which received the signal.
-
-<!-- ##### ARG GtkPlug:embedded ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPlug:socket-window ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_plug_construct ##### -->
-<para>
-</para>
-
-@plug: 
-@socket_id: 
-
-
-<!-- ##### FUNCTION gtk_plug_construct_for_display ##### -->
-<para>
-
-</para>
-
-@plug: 
-@display: 
-@socket_id: 
-
-
-<!-- ##### FUNCTION gtk_plug_new ##### -->
-<para>
-</para>
-
-@socket_id: the window ID of the socket, or 0.
-@Returns: the new #GtkPlug widget.
-
-
-<!-- ##### FUNCTION gtk_plug_new_for_display ##### -->
-<para>
-
-</para>
-
-@display: 
-@socket_id: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_plug_get_id ##### -->
-<para>
-
-</para>
-
-@plug: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_plug_get_embedded ##### -->
-<para>
-
-</para>
-
-@plug: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_plug_get_socket_window ##### -->
-<para>
-
-</para>
-
-@plug: 
-@Returns: 
-
-

diff --git a/gtk/gtkplug.c b/gtk/gtkplug.c
index 808f1f20d33f948b4d3f013fbfd215d565e57d25..0ec3e65777e423e450581fc85608999f968a06c1 100644 (file)
--- a/gtk/gtkplug.c
+++ b/gtk/gtkplug.c
@@ -37,6 +37,27 @@
 
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkplug
+ * @Short_description: Toplevel for embedding into other processes
+ * @Title: GtkPlug
+ * @See_also: #GtkSocket
+ *
+ * Together with #GtkSocket, #GtkPlug provides the ability
+ * to embed widgets from one process into another process
+ * in a fashion that is transparent to the user. One
+ * process creates a #GtkSocket widget and passes the
+ * ID of that widget's window to the other process,
+ * which then creates a #GtkPlug with that window ID.
+ * Any widgets contained in the #GtkPlug then will appear
+ * inside the first application's window.
+ *
+ * <note>
+ * The #GtkPlug and #GtkSocket widgets are currently not available
+ * on all platforms supported by GTK+.
+ * </note>
+ */
+
 static void            gtk_plug_get_property          (GObject     *object,
                                                       guint        prop_id,
                                                       GValue      *value,